<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Cortex-M4 Control Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__system__config__cm4__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Cortex-M4 Control Functions<div class="ingroups"><a class="el" href="group__group__startup__config.html">Startup</a> &raquo; <a class="el" href="group__group__system__config__cm4.html">Startup CAT1A</a> &raquo; <a class="el" href="group__group__system__config__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9f6d2ab3f6fcae1b3ddfa8144307abb8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__system__config__cm4__functions.html#ga9f6d2ab3f6fcae1b3ddfa8144307abb8">Cy_SysGetCM4Status</a> (void)</td></tr>
<tr class="memdesc:ga9f6d2ab3f6fcae1b3ddfa8144307abb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the Cortex-M4 core power mode.  <a href="#ga9f6d2ab3f6fcae1b3ddfa8144307abb8">More...</a><br /></td></tr>
<tr class="separator:ga9f6d2ab3f6fcae1b3ddfa8144307abb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac44c12fdb0562403fc055e4e8966b557"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__system__config__cm4__functions.html#gac44c12fdb0562403fc055e4e8966b557">Cy_SysEnableCM4</a> (uint32_t vectorTableOffset)</td></tr>
<tr class="memdesc:gac44c12fdb0562403fc055e4e8966b557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets vector table base address and enables the Cortex-M4 core.  <a href="#gac44c12fdb0562403fc055e4e8966b557">More...</a><br /></td></tr>
<tr class="separator:gac44c12fdb0562403fc055e4e8966b557"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4df7e46b2841b62a00ab856e5a6f098f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__system__config__cm4__functions.html#ga4df7e46b2841b62a00ab856e5a6f098f">Cy_SysDisableCM4</a> (void)</td></tr>
<tr class="memdesc:ga4df7e46b2841b62a00ab856e5a6f098f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the Cortex-M4 core and waits for the mode to take the effect.  <a href="#ga4df7e46b2841b62a00ab856e5a6f098f">More...</a><br /></td></tr>
<tr class="separator:ga4df7e46b2841b62a00ab856e5a6f098f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga339cc16be57bd7f25181a554eba100fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__system__config__cm4__functions.html#ga339cc16be57bd7f25181a554eba100fa">Cy_SysRetainCM4</a> (void)</td></tr>
<tr class="memdesc:ga339cc16be57bd7f25181a554eba100fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retains the Cortex-M4 core and exists without waiting for the mode to take effect.  <a href="#ga339cc16be57bd7f25181a554eba100fa">More...</a><br /></td></tr>
<tr class="separator:ga339cc16be57bd7f25181a554eba100fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7ec02431317f327f05a5460e0301c36c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__system__config__cm4__functions.html#ga7ec02431317f327f05a5460e0301c36c">Cy_SysResetCM4</a> (void)</td></tr>
<tr class="memdesc:ga7ec02431317f327f05a5460e0301c36c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the Cortex-M4 core and waits for the mode to take the effect.  <a href="#ga7ec02431317f327f05a5460e0301c36c">More...</a><br /></td></tr>
<tr class="separator:ga7ec02431317f327f05a5460e0301c36c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9f6d2ab3f6fcae1b3ddfa8144307abb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f6d2ab3f6fcae1b3ddfa8144307abb8">&#9670;&nbsp;</a></span>Cy_SysGetCM4Status()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysGetCM4Status </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the Cortex-M4 core power mode. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__system__config__cm4__status__macro.html">Cortex-M4 Status Macros</a> </dd></dl>

</div>
</div>
<a id="gac44c12fdb0562403fc055e4e8966b557"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac44c12fdb0562403fc055e4e8966b557">&#9670;&nbsp;</a></span>Cy_SysEnableCM4()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysEnableCM4 </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>vectorTableOffset</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets vector table base address and enables the Cortex-M4 core. </p>
<dl class="section note"><dt>Note</dt><dd>If the CPU is already enabled, it is reset and then enabled.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">vectorTableOffset</td><td>The offset of the vector table base address from memory address 0x00000000. The offset should be multiple to 1024 bytes. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga4df7e46b2841b62a00ab856e5a6f098f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4df7e46b2841b62a00ab856e5a6f098f">&#9670;&nbsp;</a></span>Cy_SysDisableCM4()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysDisableCM4 </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the Cortex-M4 core and waits for the mode to take the effect. </p>
<dl class="section warning"><dt>Warning</dt><dd>Do not call the function while the Cortex-M4 is executing because such a call may corrupt/abort a pending bus-transaction by the CPU and cause unexpected behavior in the system including a deadlock. Call the function while the Cortex-M4 core is in the Sleep or Deep Sleep low-power mode. Use the <a class="el" href="group__group__syspm.html">SysPm (System Power Management)</a> Power Management (syspm) API to put the CPU into the low-power modes. Use the <a class="el" href="group__group__syspm__functions__power__status.html#ga2b25c32ff6bc5f899352e4a8102af23f">Cy_SysPm_ReadStatus()</a> to get a status of the CPU. </dd></dl>

</div>
</div>
<a id="ga339cc16be57bd7f25181a554eba100fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga339cc16be57bd7f25181a554eba100fa">&#9670;&nbsp;</a></span>Cy_SysRetainCM4()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysRetainCM4 </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retains the Cortex-M4 core and exists without waiting for the mode to take effect. </p>
<dl class="section note"><dt>Note</dt><dd>The retained mode can be entered only from the enabled mode.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Do not call the function while the Cortex-M4 is executing because such a call may corrupt/abort a pending bus-transaction by the CPU and cause unexpected behavior in the system including a deadlock. Call the function while the Cortex-M4 core is in the Sleep or Deep Sleep low-power mode. Use the <a class="el" href="group__group__syspm.html">SysPm (System Power Management)</a> Power Management (syspm) API to put the CPU into the low-power modes. Use the <a class="el" href="group__group__syspm__functions__power__status.html#ga2b25c32ff6bc5f899352e4a8102af23f">Cy_SysPm_ReadStatus()</a> to get a status of the CPU. </dd></dl>

</div>
</div>
<a id="ga7ec02431317f327f05a5460e0301c36c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7ec02431317f327f05a5460e0301c36c">&#9670;&nbsp;</a></span>Cy_SysResetCM4()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysResetCM4 </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resets the Cortex-M4 core and waits for the mode to take the effect. </p>
<dl class="section note"><dt>Note</dt><dd>The reset mode can not be entered from the retained mode.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Do not call the function while the Cortex-M4 is executing because such a call may corrupt/abort a pending bus-transaction by the CPU and cause unexpected behavior in the system including a deadlock. Call the function while the Cortex-M4 core is in the Sleep or Deep Sleep low-power mode. Use the <a class="el" href="group__group__syspm.html">SysPm (System Power Management)</a> Power Management (syspm) API to put the CPU into the low-power modes. Use the <a class="el" href="group__group__syspm__functions__power__status.html#ga2b25c32ff6bc5f899352e4a8102af23f">Cy_SysPm_ReadStatus()</a> to get a status of the CPU. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
